home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / EDUCATE / BIBL511S.ARJ / BIBL5.DOC < prev    next >
Text File  |  1991-05-16  |  38KB  |  895 lines

  1. ┌┬─────────────────────────────────────────────────────────────────────┬┐
  2. ││ B I B L                                                Release 5.11 ││
  3. └┴─────────────────────────────────────────────────────────────────────┴┘
  4.  
  5.   This documentation covers both the SHAREWARE and REGISTERED versions
  6.  of the package.  Where information pertains to one version in particular,
  7.   it will be noted in the text.  An [R] appears in the left margin when
  8.              a registered-version-only feature is discussed.
  9.  
  10.                ** S H A R E W A R E     V E R S I O N  **
  11.  
  12.  Non-registered users of this software are granted a limited license to
  13.  make an evaluation copy for trial use on a private, non-commercial basis,
  14.  for the express purpose of determining whether BIBL meets their needs.
  15.  At the end of this trial period, (30 days) you should either register
  16.  your copy or discontinue use.
  17.  
  18.  A BIBL registration licenses you to use the product on a regular basis.
  19.  Registration provides you with access to the GMUtant Online BBS
  20.  ((703) 323-3100) as a registered user--where you may download the latest
  21.  registered release, receive support, leave questions or requests for
  22.  enhancements. The registered version of BIBL does not contain the opening
  23.  registration reminder and has expanded capabilities.
  24.  
  25.  Registering BIBL will also allow you to download special programs from
  26.  the GMUtant OnLine BBS--for example, BIBL286 is a version of BIBL using
  27.  machine code for the 80286 or 80386 processor. This allows BIBL to take
  28.  better advantage of these CPUs and creates a slightly smaller BIBL5.EXE
  29.  file. BIBL5IN supports reading ASCII files into BIBL--e.g., use
  30.  data you download (from BRS, Dialog, CD-ROMs, etc.) to build your
  31.  database.
  32.  
  33.  Registration requires a contribution of $ 25.00 to the author, as a
  34.  reimbursement for the time spent working on this program.
  35.  
  36.  BIBL source code is available for a payment of $ 80.00 ($25.00 for
  37.  registration, $ 51 for source, $ 4.00 for postage and diskette by return
  38.  mail).  If you have registered a previous version of BIBL, you are also
  39.  a registered user of any subsequent version.  You may upgrade at any time
  40.  by sending $ 4.00 to the address below. The latest version will be sent.
  41.  
  42.           Send your name, address and registration payment to:
  43.  
  44.                           Clyde W. Grotophorst
  45.                             Route 1, Box 296
  46.                         Hamilton, Virginia 22068
  47.  
  48.                         ** CREDIT CARD ORDERS **
  49.  
  50. You may also order the registered version of BIBL from Public (software)
  51. Library with your MasterCard, Visa, American Express, or Discover Card by
  52. calling 800-2424-PSL or 713-524-6394 or by FAX to 713-524-6398, or by
  53. CompuServe to 71355,470 or by mail to PsL, P.O. Box 35705, Houston, Texas
  54. 77235-5705.  These numbers are for ordering only.  The cost is $ 29.00 which
  55. includes a copy of the latest registered version to you by return 1st class
  56. mail.
  57.  
  58.  
  59.  
  60. We've included sample records with BIBL for demonstration purposes. The
  61. sample database and index are inside B5DEMO.EXE. Type B5DEMO at the DOS
  62. prompt to extract these files. You may delete BIBL5.DAT and BIBL5.IX when
  63. you are ready to begin entering information you want to keep. To see the
  64. sorts of things included in the sample file, and to study how you might
  65. use the fields in a BIBL record, activate BIBL5 then press L, the last record
  66. in the file will display. Press [B] to move backward through the
  67. file.
  68.  
  69.                        Q U I C K S T A R T
  70.  
  71. Copy BIBL5.EXE to a sub-directory on your disk (e.g., C:\BIBL)
  72. then type BIBL5 to activate the program. Empty versions of the
  73. needed files (BIBL5.DAT and BIBL5.IX) will be created. If you want
  74. to use the sample database instead of beginning with an empty
  75. one, type B5DEMO before running BIBL. This will extract the
  76. demonstration files (BIBL5.DAT and BIBL5.IX). When you're ready to
  77. begin with your own data, delete BIBL5.DAT and BIBL5.IX, then
  78. reactivate BIBL.
  79.                  
  80. BIBL Features [SHAREWARE and REGISTERED]:
  81.  
  82. - menu-driven.
  83. - easily understood user interface (bounce-bar menus or accepts first
  84.   letter of each command).
  85. - five indexes are maintained (in a single file) for fast retrieval and
  86.   sorted extracts (author, author/title, title, subject, and descriptor).
  87. - up to 8 words from the descriptor field are indexed individually.
  88. - produces bibliographies in three forms (brief, annotated and
  89.   full) based on information in any field. Each bibliography is
  90.   sorted by author, then within author, by title.
  91. - user-selected fields for output (soft return option available).
  92. - when no match is made on an indexed search, BIBL displays where
  93.   in the index your query would have appeared (near misses).
  94. - produces a wide variety of lists (in ASCII form) which may be
  95.   printed or edited with any word-processor that accepts ASCII
  96.   files for input.
  97. - Global change for subject field supported.  BIBL will count
  98.   number of affected records before initiating change, if desired.
  99. - if desired, BIBL will run in a 'read-only' mode. This allows copies of
  100.   your database to be accessed by the public but protects against editing,
  101.   deleting or otherwise modifying the database.
  102. - BIBL offers an ASCII file viewer that supports a mouse, and is
  103.   moveable, resizeable, and ZOOMable.
  104. - BIBL reserves memory (heap) for indexes in a dynamic fashion--improving
  105.   retrieval speed.
  106. - Index graph shows progress as indexing/reindexing occurs
  107. - ability to print or save to disk any individual record.
  108. - main menu screen always reports number of records in the file
  109.   and whether a file of saved records (SAVEFILE) exists.
  110. - empty records (e.g., after deletions) are used as new records
  111.   are added.
  112.  
  113.                                  - 2 -
  114.  
  115.  
  116. Features (continued):
  117.  
  118. - Boolean OR and AND searching supported for descriptor field.
  119. - Selected reports (list of subjects, list of titles, etc) may be
  120.   viewed onscreen and/or sent to disk.
  121. - BIBL can produce a comma-delimited file of the database. This
  122.   allows import to dBASE or other DBMS packages.
  123. - any ASCII file may be used for display when I (INFORMATION) is pressed
  124.   on the main menu.
  125. - Shell to DOS (uses heap compression to free as much memory as possible).
  126. - Install editor/viewer. Allows user to install an external
  127.   program for use as the editor/viewer under File Maintenance options.
  128.  
  129.  
  130. The REGISTERED version adds these features:
  131.  
  132. - A larger percentage of free RAM is devoted to in-memory index
  133.   storage (30% of RAM remaining after BIBL is loaded). This
  134.   greatly speeds retrieval and reduces disk I/O for larger databases.
  135.  
  136. - External editor. The registered version uses advanced memory
  137.   management to swap most of BIBL out of memory (to disk or EMS if
  138.   available) during this process, allowing use of very large
  139.   programs (e.g., WordPerfect 5.1) as the editor.  BIBL shrinks to
  140.   a 60K kernel in memory, all other RAM is devoted to your second
  141.   application.
  142.  
  143. - Bibliographies (option D under EXPORT) as well as other reports
  144.   may be created in 'word-processing' form (this will put soft
  145.   returns in your file within a given citation, hard returns
  146.   between them).  This makes it much easier to do subsequent
  147.   editing of your bibliography with a word processor.
  148.  
  149. - Bibliographies.  Registered version supports export of records
  150.   based on ANY field in the record, not just Author, Publisher,
  151.   Subject, or Descriptor.
  152.  
  153. - BIBL will run in 43/50 line mode.
  154.  
  155. - BIBL can be configured so that BIBL5.DAT and BIBL5.IX are on
  156.   a different drive (often helpful in networked environments).
  157.  
  158.                                  - 3 -
  159.  
  160.  
  161.                         I N S T A L L A T I O N
  162.  
  163. Copy BIBL5.EXE and BIBL5.HLP to a sub─directory.  If you want to
  164. experiment with the sample database we provide, copy B5DEMO.EXE
  165. to this sub-directory as well.  Type B5DEMO at the DOS prompt
  166. to extract the demostration files, then type BIBL5 to activate the
  167. program.  After you have experimented with the capabilities of
  168. BIBL using the demo database, delete BIBL5.DAT and the BIBL5.IX
  169. file. When you next activate BIBL, it will create new empty
  170. versions of these files.
  171.  
  172. Be sure your CONFIG.SYS file contains the following minimum
  173. values: FILES=20, BUFFERS=20.  REGISTERED USERS: If you intend to
  174. use a large program like WordPerfect as your external editor,
  175. you may have to increase these numbers.  We have found that
  176. FILES=30 should suffice.
  177.  
  178.                 S Y S T E M    O V E R V I E W
  179.  
  180. BIBL (rhymes with nibble) is a simple to use online catalog for
  181. your personal library. Written in Turbo Pascal 6.0 and using full
  182. B-tree indexing (thanks to TurboPower's B-Tree Filer package),
  183. the system is fast, small, and very efficient. Menu-driven, BIBL can
  184. be used to track your book collection, article reprints, index your
  185. vertical file, manage a small office library, and so on...
  186.  
  187. In most areas bounce-bar menus are used. To select a particular
  188. option, move the bar via the cursor until your desired operation
  189. is highlighted, then press RETURN. If you're a touch typist, you
  190. might prefer pressing the initial letter of the choice you wish
  191. to make (e.g., Press S to activate SEARCH).
  192.  
  193. Command Line Switches
  194.  
  195. If on a monochrome monitor you find you can not clearly read the
  196. various BIBL status line displays, activate program with an '/m'
  197. switch (for mono), e.g., BIBL /M <cr>.
  198.  
  199. OPAC (Online Public Access Catalog) . If you want to have others
  200. use your BIBL database but don't want them adding, deleting, or
  201. editing records, begin BIBL with the /p switch. This activates
  202. OPAC mode, disabling writing to the database (BIBL5.DAT).
  203.  
  204. You may use both the mono and opac switches, or just one. To use
  205. both you would begin BIBL with the following command line: BIBL /m /p <cr>
  206.  
  207.                                  - 4 -
  208.    
  209. ** Registered Users **
  210.  
  211. [R] BIBL will also run in 43 or 50 line mode (EGA or VGA) if you
  212. [R] start the program with a /v switch. BIBL will automatically
  213. [R] detect the resident hardware and make the appropriate setting.
  214. [R] Upon exit, the 25 line mode will be restored.  If you use
  215. [R] WordPerfect 5.1 as your installed editor/viewer, and are 
  216. [R] BIBL in the 43/50 line mode, your call to WordPerfect will
  217. [R] switch that package into 43/50 line mode as well.
  218.  
  219.  
  220. I. ADDING RECORDS TO THE DATABASE
  221.  
  222. The database is limited to 2 billion records although you'll
  223. probably run out of disk space before that becomes an issue. To
  224. begin working toward that 2 billion, press A as the main menu
  225. is displayed. 
  226.  
  227. A blank record will appear on the screen. Enter data in the
  228. highlighted fields. If you want to skip a field, just press
  229. RETURN when the cursor is inside that field's highlighted box.
  230. When you are finished, either press return when the highlighted
  231. box is in line 6 of the note field, or press ESC.
  232.  
  233. BIBL will then ask you about the disposition of this record,
  234. via an 'OK to file' prompt.  
  235.  
  236. Answer:
  237.  
  238. [Y]  Yes, file record. This will add the record to the database
  239.      and update the index file.
  240. [N]  No, edit Record. This returns the cursor to the first field
  241.      of the record, allowing you to continue editing the
  242.      information.
  243. [A]  Abort. This abandons the information and returns you to the
  244.      main menu.
  245.  
  246. BIBL INDEXING
  247.  
  248. Five indexes are maintained in the single file BIBL5.IX
  249. 1) the first 20 characters of the author field, 25 characters of
  250. the TITLE field, the entire SUBJECT field, each word (something with a
  251. space before and after it) of the DESCRIPTOR field (must be more
  252. than a single character), and a fifth index used to create temporary
  253. sorts (by call number, author/title, etc.).
  254.  
  255. Information is stored in upper case in the index file and your
  256. query is converted to upper case before a search begins--thus you
  257. don't have to worry about capitalization (although the way you
  258. enter data is the way it will display and appear in any ASCII
  259. file created by BIBL.
  260.                                  - 5 -
  261.  
  262. FIELDS (Subject vs Descriptor): Most fields are obvious, but you
  263. might not be familiar with the distinction we're making between
  264. subject and descriptors. Put the most important term in the
  265. subject field and other less useful but desired descriptive terms
  266. in the DESC: field.
  267.  
  268. The DESCRIPTOR field uses a keyword index--wherein each word of
  269. the field is indexed.
  270.  
  271. Caution: No word in the descriptor field can be longer than 20
  272. characters (or it will be truncated to 20 characters in the
  273. index). The indexing algorithm considers a word to be anything
  274. between two blank spaces. If you have a compound term, include a '-'
  275. between the words so they'll be considered a single term
  276. (e.g., 'World-War-II' is considered 1 term while 'World War II'
  277. is three.). Up to 8 words in any one DESC field will be indexed.
  278. A single letter WILL NOT be indexed. Each 'word' must be longer
  279. than one character.
  280.  
  281. CLASSIFICATION: Use the classification field for whatever you
  282. like but we envision it storing things like 'Book',' Journal
  283. Article', 'Review article', 'Newspaper' and so on. If you use a
  284. numbering scheme then that information could be stored there (as
  285. could location information).
  286.  
  287. There are two ways under the EXPORT sub-menu to produce a report
  288. sorted on Classification number: Option [L] (4/1/2) and/or option
  289. [M] (User-Defines).
  290.  
  291. II. SEARCHING THE DATABASE
  292.  
  293. To search, press S at the main menu, then via the light bar
  294. select which field you wish to  search (Author, Title, Subject,
  295. Note, etc.).
  296.  
  297. Once you have selected the field you wish to search, a 'QUERY'
  298. box will appear. Enter the text you wish to locate in this box,
  299. at the 'Query >>' prompt.
  300.  
  301. You may search text in ANY field of a BIBL record. Matches are
  302. made using your input as a stem; that is, if you enter SMI and
  303. SMITH exists, you'll get a match. Another way of saying this is
  304. 'implied truncation.'
  305.  
  306. Note that while retrieval on indexed fields is very fast,
  307. searching non-indexed fields (e.g., line 3 of the note field) is
  308. much slower. On non-indexed fields, BIBL must read each record,
  309. comparing your query with the contents of the field. You may
  310. abort a non-indexed search by pressing any key to interrupt.
  311.  
  312. On indexed field searches, if BIBL can not find a match for your
  313. query, it will display several index entries that come before and
  314. after where your query would have fallen in the index.
  315.  
  316.                                  - 6 -
  317.  
  318. As your database grows, this type display will help you fine-tune
  319. your search query.
  320.  
  321. If you want to abandon searching after you have selected a
  322. particular field to search, press RETURN instead of entering a
  323. search statement at the 'Query >>' prompt. You will be returned
  324. to the main menu.
  325.  
  326. Use BOOLEAN descriptor search to search for more than 1 term in
  327. the Descriptor field. You may enter only 2 terms and they must be
  328. connected by either AND or OR. For example: COMPUTERS and
  329. HARDWARE is fine but COMPUTER HARDWARE AND TESTING will work only
  330. if the terms COMPUTER HARDWARE appear together in the descriptor
  331. field! This BOOLEAN search *DOES NOT* use the index so searching
  332. is slow.
  333.  
  334. PRINTING? Whenever an individual record is displayed during the
  335. search function, you may print the record by pressing 'P'.
  336.  
  337. III. EDITING/DELETING RECORDS IN THE DATABASE
  338.  
  339. BIBL allows complete editing of any record in the file. To edit a
  340. record, locate the desired record via the Search function. When
  341. the record you wish to modify is displayed, press 'E' to enter
  342. the EDIT mode.
  343.  
  344. As you first enter EDIT mode, the author's name field will be
  345. highlighted.
  346.  
  347. If you want to change that field, enter new information.  If you
  348. want to edit a different field, press RETURN until the
  349. highlighted area is in the field you want to change. When you
  350. have finished making changes, press ESC or press RETURN with line
  351. 4 of the note field highlighted.  You will
  352. receive an 'OK to file (y/n)?' prompt.
  353.  
  354. If you respond to the 'OK to File (y/n)?' prompt with:
  355.  
  356.    Y - The record (as displayed) will be filed in the database.  
  357.        The index file will be updated if your editing has changed
  358.        an indexed field.
  359.  
  360.    N - Any changes made will be discarded. The original record
  361.        redisplays.
  362.  
  363.                                  - 7 -
  364.  
  365. You may also enter EDIT mode via the 'List records in the
  366. database' option from the main menu. The only difference between
  367. editing from this menu choice instead of SEARCH is that BIBL will
  368. display all records in the database, beginning with the first
  369. record.
  370.  
  371.  
  372. IV.  SYSTEM MAINTENANCE
  373.  
  374. The MAINTENANCE function offers several options:
  375.  
  376.    - Global Change
  377.    - Rebuild Indexes
  378.    - Call External Editor/Call Up Any ASCII files
  379.    - Shell to DOS
  380.    - Install Editor/Viewer
  381.    - UnInstall Editor/Viewer
  382.  
  383. A. GLOBAL CHANGE
  384.  
  385. First, use the LIST SUBJECTS option (under EXPORT/VIEW) to see
  386. what subjects are used in your file.  Select GLOBAL CHANGE from the
  387. Option Menu. You are allowed to make changes in the subject field
  388. only.
  389.  
  390. How?
  391.  
  392. 1.   Enter the old text as it now appears in the BIBL records
  393. you want to change (case is not important, but a character for
  394. character match is required-- e.g., BaSeBaLL will match BASEBALL,
  395. but just entering 'BASE' won't work).
  396.  
  397. 2.   Enter the text you would like to have replace the old subject
  398. field's value (here case is important--as the text you enter here
  399. will be put in your records).
  400.  
  401. 3.   If desired, BIBL will run through your database, counting the
  402. number of records affected by the proposed change. We recommend
  403. this step since if the number is very high or very low, you'll
  404. have an idea that something might be wrong.
  405.  
  406. 4.   If you elect to make the change, BIBL will correct the
  407. appropriate record(s) then rebuild the subject index.
  408.  
  409. B. REBUILDING INDEXES
  410.  
  411. As mentioned earlier, when BIBL is first activated it checks to
  412. see if the database file (BIBL5.DAT) and the index file (BIBL5.IX)
  413. exist. If so, they are used; if not, they're created.
  414.  
  415.                                  - 8 -
  416.  
  417. We include an index rebuild function to create new indexes from
  418. the database file on demand. You may never need this function,
  419. but if add records through the ASCII import function; take a
  420. power hit during data entry, or experience some other sort of
  421. hardware (disk) failure, the indexes can become invalid or
  422. corrupted.  
  423.  
  424. Rebuilding indexes will correct any problems of this sort. When
  425. rebuilding the indexes, BIBL provides a graph which shows the
  426. status of the effort (0%-100% complete for each index). Note: the
  427. graph appears only if the database size exceeds 10 records.
  428.  
  429. If you experience SERIOUS problems with your database, run the
  430. utility program BIBL5RX...which rebuilds both the datafile and
  431. the indexes.
  432.  
  433. C. CALL EXTERNAL EDITOR/CALL UP ASCII FILE
  434.  
  435. You may view your savefile (QUERY.TXT) or any other ASCII file
  436. from within BIBL.  The viewer built into BIBL is quite powerful.
  437. It responds to a mouse, and the following commands:
  438.  
  439. F5       Zoom the view window to fill the screen
  440. ALT-F5   Resize the window (Press ALT-F5 then with the cursor keys
  441.          size the window until it meets your needs, then press
  442.          RETURN.
  443. CTRL-F5  Move the window.  Press CTRL-F5 then move the window with
  444.          the cursor arrow keys. Press RETURN when done
  445.  
  446. PgUp/PgDn       Move up and down in the document a screen at the time.
  447. CTRL PgUp/PgDn  Move to the top or bottom of the document
  448.  
  449. ESC or F10   Close the window and return to BIBL.
  450.  
  451. If you have an external program linked to BIBL, that program is called
  452. and passed the name of the file you want to view.
  453.  
  454. D. SHELL TO DOS
  455.  
  456. BIBL allows you to drop out of the program momentarily and return
  457. to your DOS prompt.  This option allows you to delete files,
  458. use a program like LIST to view a file, check disk space, or
  459. do other DOS-type things. BIBL provides a special prompt to remind
  460. you to enter the word EXIT to return to the program...
  461.  
  462. When you type EXIT, BIBL will reactivate and check to see that
  463. the operating system is still defaulting to the sub-directory
  464. where your BIBL files (BIBL5.DAT and the indexes) are kept.  If
  465. not, BIBL will change to that drive and directory before
  466. continuing.  If BIBL is unable to change to the original
  467. sub-directory, you will receive a message to that effect...so you
  468. can manually issue the command (e.g., CD\BIBL <cr>) from the DOS
  469. prompt. During testing of this procedure, the only time we could
  470. thwart BIBL's ability to return to the original directory was
  471. when we erased it while at the DOS prompt!
  472.  
  473.                                  - 9 -
  474.  
  475. E. INSTALL EDITOR/VIEWER
  476.  
  477. BIBL allows you to specify some program other than BIBL to handle
  478. viewing of your save file or other text files. If you elect to
  479. use this option, you should select a program that is small (like
  480. the widely-available shareware file-viewer LIST (LIST.COM)). 
  481. Whichever program you choose, it will have to run in the amount
  482. of memory left over after BIBL is loaded.  So unless you have
  483. the registered version, don't bother trying to use WordPerfect.
  484.  
  485. Also, the program you use must be capable of accepting a file 
  486. name as a command line argument, e.g., LIST filename <cr>
  487.  
  488. BIBL will send the name of your external program (drive, path,
  489. program name and extension) to DOS as well as the name of the
  490. file (drive, path, filename, and extension).  This allows you to 
  491. access an external program on another drive if desired.
  492.  
  493. If you have an external program defined, BIBL changes the file
  494. maintenance menu prompt from "CALL UP AN ASCII FILE" to "CALL
  495. EXTERNAL EDITOR/VIEWER"
  496.  
  497. BIBL creates a simple configuration file (BIBL.CFG) when an
  498. external viewer/editor is defined. If you want to remove the
  499. editor/viewer altogether, just delete the BIBL.CFG file. If you
  500. later install another package, BIBL will create the configuration
  501. file again.
  502.  
  503. If BIBL encounters a problem (too little memory, invalid name for
  504. the viewer/editor program, viewer/editor not found in path,
  505. etc.), it will just ignore the request and return to the main
  506. menu.
  507.  
  508.  
  509. [R]  The Registered version of BIBL goes an extra step to
  510. [R]  increase your flexibility in installing an editor/viewer. In
  511. [R]  addition to compressing the memory heap (as in the Shareware
  512. [R]  version), BIBL also swaps most of itself out to disk (or EMS
  513. [R]  if available), freeing up a great deal more system memory your
  514. [R]  editor/viewer.  EMS will be automatically detected and used if
  515. [R]  available, otherwise the swap is to disk.  While the program
  516. [R]  normally requires 350K or more to run, after compressing
  517. [R]  itself and swapping out, only a 55-65K kernel of BIBL remains
  518. [R]  in memory--enabling you to use a very large program (e.g.,
  519. [R]  WordPerfect) as your editor/viewer.  When the external program
  520. [R]  finishes, BIBL returns!
  521.  
  522.                                  - 10 -
  523.  
  524. V. OUTPUT OPTIONS / REPORTS / BIBLIOGRAPHIES
  525.  
  526. While BIBL offers only limited print support, it will dump your
  527. database to disk in an ASCII file--which you can then edit and
  528. print using your favorite word processor.
  529.  
  530. Blank fields do not appear in the ASCII files BIBL can create
  531. (the exception being DELIMITED format).
  532.  
  533. You may select Author, Title, Subject, Delimited or the order
  534. records appear in the database. Note that each time you call the
  535. dump to disk routine it overwrites any previously created file.
  536.  
  537. Here is a list of the files created via the Export function. Where
  538. you are given the option of naming the file, you should use a *.TXT
  539. extension when possible. This will allow you to see all available
  540. export files under the CALL EXTERNAL EDITOR function when you accept
  541. the default *.TXT mask.
  542.  
  543. Content            Name BIBL will give ASCII file
  544.  
  545. Author             AUTHLIST.TXT (sorted by author, then title)
  546. Title              TITLLIST.TXT
  547. Subject            SUBJLIST.TXT
  548. Delimited          BIBLDLM.TXT
  549.  
  550. Bibliographies     User names this file. Registered version also 
  551.                    offers option of using SOFT RETURNS.
  552.  
  553. [Index View/Dump] 
  554.  
  555. Keyword List                   KEYWORD.TXT
  556. Extract Titles (Title+Author)  TIBRIEF.TXT
  557. List of Subjects (Subj+Title)  SUBRIEF.TXT
  558. List of Authors (Author+Title) AUBRIEF.TXT
  559.  
  560. Other
  561.  
  562. 1/2/4 (Author/Title/Class)     ATCLIST.TXT
  563. 4/1/2 (Class/Author/Title)     CATLIST.TXT
  564. User-Defined                   User names this file. WP format 
  565.                                (soft returns) available.
  566.  
  567. Here is a sample of the ATCLIST.TXT file...note that fields will be
  568. truncated in this and the CATLIST file:
  569.  
  570. Author                   Title                              Class
  571.  
  572. Bevilacqua, Ann F.       Hypertext: Behind the Hype.        article
  573. Boswell, Thomas          The Heart of the Order             book
  574. Brandt, Scott            Authority Files for Microcomputer  article
  575. Bratley, Paul and Choue  Processing Truncated Terms in Doc  Box 3,Folder 9
  576. Byrne, Alex and Mary Mi  Improving OPAC Subject Access: Th  Box 4,Folder 2
  577. Carroll, David M. And O  Bibliographic Pattern Matching Us  article
  578.  
  579.                                  - 11 -
  580.  
  581. BIBLIOGRAPHIES
  582.  
  583. A rudimentary bibliography generator, BIBL will create ASCII text
  584. files (in full record, annotated, or brief form) for all records
  585. that contain your search string.  You tell BIBL what field you want
  586. to search, and what text you are seeking.  BIBL then produces an
  587. ASCII file of all records that contain the text you entered.
  588.  
  589. [R] Registered version of BIBL will also create output using soft
  590. [R] returns (instead of ASCII hard returns) after each line.
  591.  
  592. Annotated form will produce a listing with author, title, publisher
  593. and the notes fields.  Brief includes only the author, title, and
  594. publisher field. Below, a sample 'annotated' reference appears:
  595.  
  596. Bratley, Paul and Choueka, Yaacov
  597.      Processing Truncated Terms in Document Retrieval Systems.
  598. Information Processing and Management v18 n5 p257-66 1982
  599.  
  600.      Presents uniform and efficient approach for processing all
  601. truncated query terms in information retrieval which requires one
  602. disk access to obtain from the permuted dictionary all strings
  603. represented by truncated term. The problem of the overhead
  604. storage required to implement the permuted dictionary is
  605. discussed. Fifteen references.
  606.  
  607. You assign the name for the bibliography output file. If the name
  608. is already in use, BIBL asks you to use another name.
  609.  
  610. Note that using the Word Processing [WP] format option will produce
  611. a citation where fields follow one another on a line.  A hard return
  612. follows the PUBL field.
  613.  
  614.      Bratley, Paul and Choueka, Yaacov.  Processing Truncated
  615. Terms in Document Retrieval Systems. Information Processing and
  616. Management. v18 n5 p257-66. 1982.
  617.  
  618.                     'Smart' Punctuation [WP format]
  619.  
  620. [R] As BIBL creates your bibliography, it will check to see whether
  621. [R] each field ends with punctuation.  If so, the existing
  622. [R] punctuation will be written to your output file.  If not, BIBL
  623. [R] will add periods after each field.  This saves you having to
  624. [R] use end-of-field punctuation in your BIBL database entry. 
  625.  
  626. DELIMITED FORMAT
  627.  
  628. Delimited format is used when you want to move your BIBL database
  629. to dBASE or some other database system.  The next few paragraphs
  630. point out a few things you should be aware of:
  631.  
  632.                                  - 12 -
  633.  
  634. Note that in delimited format BIBL will change any quotation mark
  635. that appears in the Title, Descriptor, or Note fields to a single
  636. quote--to preserve the exported data's integrity. If any double
  637. quotes were to appear in the exported data (that is, anywhere
  638. other than between the fields), the the importing program might
  639. not process the data correctly.
  640.  
  641. For example, if you have: Jones is author of the article, "This
  642. is My Life's Work." in your note field, under delimited format,
  643. BIBL will export: "Jones is author of the article, 'This is My
  644. Life's Work.'"
  645.  
  646. A CR/LF appears at the end of each record. dBASE will accept this
  647. for input if you first set up a dBASE file with the proper
  648. structure. Use the field lengths as they appear at the end of
  649. this documentation. With the database structure created activate
  650. dBASE and issue the following command:
  651.  
  652.      . USE MYBOOKS <cr>
  653.      . APPEND FROM BIBLDLM.TXT DELIM <cr>
  654.  
  655. LIST SUBJECTS/LIST DESCRIPTORS (Keywords)
  656.  
  657. You should use these export functions periodically to check the
  658. uniformity of your subject headings and descriptor fields. For
  659. example, if your list shows you have 10 items under computer and
  660. 1 under computers, you should edit the COMPUTERS entry (changing
  661. it to COMPUTER). As an aid in helping you identify the records, a
  662. bit of the title is included with each entry. 
  663.  
  664. Note that there is an entry in the list for each heading in a
  665. record (if you have 10 records with the subject BASEBALL, you'll
  666. get 10 entries for BASEBALL in the SUBJECTS.TXT file).
  667.  
  668. Related Topic: Send To Disk.  Beyond creating large reports, during
  669. any search you may elect to send a copy of a single record to an
  670. ASCII file (QUERY.TXT). Each time you press 'S' a copy is appended
  671. to this file.  When you are finished with the file, delete it (via
  672. DOS) or rename it. Then when you next send a record to disk, BIBL
  673. will create a new copy of QUERY.TXT.
  674.  
  675. The opening menu screen for BIBL always reports on the existence
  676. of a SAVEFILE.  It may be deleted during Rebuild Indexes or via
  677. the DOS Del command within the SHELL TO DOS function.
  678.  
  679.                                  - 13 -
  680.  
  681.                           USAGE NOTES
  682.  
  683. The following section covers a few uses for BIBL then focuses
  684. particular attention on using BIBL with WordPerfect.
  685.  
  686. A. What some other users are doing with BIBL:
  687.  
  688.  - maintain an online index to your personal book collection.
  689.  - track magazine articles you read and want to remember.
  690.  - in a library, BIBL can be used to provide an index of your
  691.    vertical file (for non-library types, a vertical file is usually
  692.    a filing cabinet of clippings, brochures, and the like).
  693.  - use BIBL instead of 3x5 cards for research. When you're done,
  694.    it can create a bibliography for you.
  695.  - keep track of reserve reading materials.  The '/P' (OPAC) 
  696.    switch is nice here, since other users can read but not modify
  697.    your database.
  698.  - Manage your office library. If you have branches, send them a
  699.    copy of BIBL5.EXE and your *.DAT and *.IX file.  They can use
  700.    the SEND TO DISK option to create a list of materials they'd
  701.    like you to send to the branch.
  702.  
  703. B. Using WordPefect (5.0 or 5.1) as your external editor (or viewer
  704.    or printer).
  705.  
  706. [R]  While BIBL does not possess a direct interface to WordPerfect
  707. [R]  it does work particularly well with that word processor.
  708. [R]  Follow the sequence below to install WordPerfect as your
  709. [R]  external editor.
  710.  
  711. [R]  Note: the sequence is the same for any word-processor...just
  712. [R]  be sure that the program accepts a filename to edit on the
  713. [R]  command line (e.g., WP MYFILE [RETURN] on the DOS command line
  714. [R]  will start WordPerfect and load a file named MYFILE.
  715.  
  716. 1. Select MAINTENANCE from the BIBL main menu (press M)
  717. 2. Press I (Install Editor/Viewer).
  718. 3. Enter the full path name to your copy of WP.EXE
  719.    (e.g., C:\WP51\WP.EXE).
  720.  
  721. [R] Now, when you select CALL UP ASCII FILE under the MAINTENANCE option, 
  722. [R] BIBL will load WordPerfect and pass along the name of the file you 
  723. [R] want to view, edit or print.  When you are finished with the document,
  724. [R] press F7 to save and then exit WordPerfect...you will be returned to 
  725. [R] BIBL.  The file you worked on is stored on the drive and sub-directory
  726. [R] where BIBL5.EXE resides.
  727.  
  728.                                  - 14 -
  729.  
  730. C. Using WordPerfect with the SHAREWARE version of BIBL.  
  731.  
  732. While WordPerfect is too large to use as an external editor, the [WP] format 
  733. option (which uses soft returns) is still very useful with WordPerfect.  
  734. The [WP] format option is available under option [M] (User-Selects) of 
  735. the EXPORT menu (and for registered users, under option [D] (Bibliographies) 
  736. as well).
  737.  
  738. D. Using BIBL's [WP] format with WordPefect.
  739.  
  740. Here is how you could create a WordPerfect-ready version of your database, 
  741. (printing author, title and publisher fields), sorted by Author, then title:
  742.  
  743. 1. Press E on the BIBL main menu (EXPORT).
  744. 2. Press M (user-selects).
  745. 3. Answer 'Y' that you want to continue.
  746. 4. Enter 123 and press return (to indicate that you want fields 
  747.    one (author), two (title) and three (publisher).
  748. 5. Enter 'Y' to indicate that you're satisfied with these fields.
  749. 6. Enter 1 to indicate that sort should be on author (it will actually 
  750.    be on author, then title within author).
  751. 7. Enter 'E' to indicate that you want [WP] format.
  752. 8. Enter the name you want to give your output file.
  753.  
  754. If you are using the SHAREWARE version of BIBL, quit the program, copy
  755. the file you just created to your WordPerfect sub-directory, then type
  756. WP xxxx.xx (where xxxx.xx is your file) at the DOS prompt.
  757.  
  758. [R] If you are using the REGISTERED VERSION and have installed WordPerfect
  759. [R] as your External Editor, once BIBL finishes making your file and returns
  760. [R] to the main menu, press M (for Maintenance), Then press C to 'CALL 
  761. [R] External Editor, enter the name you gave the file in step 8 (or just 
  762. [R] hit return and pick from the *.TXT files displayed), then sit back as 
  763. [R] BIBL compresses itself, then loads WordPerfect (passing along the 
  764. [R] name of your file). 
  765.  
  766. If you need to reset your margins, go to the top of the document and 
  767. press SHIFT-F8, then L (for Line), then M for margins.
  768.  
  769.                                  - 15 -
  770.  
  771.  
  772. E. Modifying HELP display (INFORMATION on the main menu).
  773.  
  774.  BIBL5 displays the file BIBL5.DOC when I is pressed on the main menu.
  775.  If you want to change the help display file, just rename ANY ascii
  776.  file to BIBL5.DOC and BIBL5 will display it...
  777.  
  778.  Be sure to make a backup copy of this documentation file before
  779.  you use the name on another file!
  780.  
  781.  
  782.                            Technical Specs:
  783.  
  784. 1. Memory required.  BIBL requires a minimum of 350K RAM to operate.
  785. If you have more, then more will be available when you Shell to DOS,
  786. and to load an external program.
  787.  
  788.  [R]  Additional RAM (beyond 330K) will also improve performance
  789.  [R]  of the Registered Version of the program.  BIBL will use
  790.  [R]  20% of available RAM after 330K for in-memory index storage.
  791.  [R]  This will speed retrieval, re-indexing, etc.
  792.  
  793. 2. Using dBASE (structure of record)
  794.  
  795. dBASE structure for a BIBL record (use this to set up a dBASE file which
  796. you will then append to using BIBL's 'delimited' export function). You
  797. may call your fields anything you like but they must be this length, and
  798. in this order:
  799.  
  800.     Fieldname Length Type
  801.  
  802.     AUTHOR1    70  C
  803.     AUTHOR2    70  C
  804.     TITLE1     70  C
  805.     TITLE2     70  C
  806.     TITLE3     70  C
  807.     PUBLISHER  70  C
  808.     CLASS      40  C
  809.     SUBJECT    30  C
  810.     flag1       1  C
  811.     flag2       1  C
  812.     flag3       1  C
  813.     value       7  C
  814.     DESC       60  C
  815.     NOTE1      70  C
  816.     NOTE2      70  C
  817.     NOTE3      70  C
  818.     NOTE4      70  C
  819.     NOTE5      70  C
  820.     NOTE6      70  C
  821.  
  822.                                  - 16 -
  823.  
  824. PASCAL structure for a BIBL record:
  825.  
  826.     bookrec = RECORD
  827.       recordstatus : longint;
  828.        author1      : string[70];
  829.        author2      : string[70];
  830.        Title1       : string[70];
  831.        title2       : STRING[70];
  832.        title3       : string[70];
  833.        publ         : STRING[70];
  834.        class        : STRING[40];
  835.        subject1     : string[30];
  836.        subject2     : STRING[60];
  837.        flag1        : char;
  838.        flag2        : char;
  839.        flag3        : char;
  840.        value        : string[7];
  841.        note1        : STRING[70];
  842.        note2        : STRING[70];
  843.        note3        : STRING[70];
  844.        note4        : STRING[70];
  845.        note5        : STRING[70];
  846.        note6        : STRING[70];
  847.      END;
  848.                                         
  849. Indexes (the following keys are maintained in BIBL5.IX):
  850.  
  851. Author     - first 20 characters of the field (stored upper case)
  852. Title      - first 25 characters of the field (stored upper case)
  853. Subject    - all 30 characters of the subject1 field (stored upper case)
  854. Descriptor - first each word of the field is extracted (a word being
  855.              a string of characters separated by a space or comma).
  856.              Up to 20 characters of each 'word' is indexed.
  857.              Up to 8 words from any one line are indexed.  If you
  858.              have 9 words on the line, the ninth is ignored.
  859.  
  860.              IMPORTANT: place a '-' between words you want BIBL
  861.              to treat as a single entry.
  862.  
  863. A fifth index is reserved for 'on-the-fly' reports (bibliographies,
  864. sort on publisher or class field, etc).  Data stored in this index
  865. is compressed (to allow larger text values to be represented.  The
  866. key length is 15 characters although with data compression, 20
  867. characters are used to build the key).
  868.  
  869. During bibliography production (Option D on Export Menu), the key value
  870. for this fifth index is: author(14 characters)+title (6 characters)
  871. which yields an author/title sort.
  872.  
  873. During User-Defined output (Option M on Export Menu), with a sort on
  874. the CLASS field (field #4), the sort key is class(15 characters)+
  875. author(5 characters), to yield a class/author sort.
  876.  
  877. If publisher field sort is selected for Option M, then 20 characters of
  878. the publisher field are used to generate the key.
  879.  
  880.                                  - 17 -
  881.  
  882.  
  883.  
  884. Questions, comments, complaints, encouragement???
  885.  
  886. Contact:
  887.  
  888. Clyde W. Grotophorst, Route 1, Box 296, Hamilton, VA 22068
  889. (703) 323-2317 or call the GMUtant OnLine BBS (703) 323-3100
  890. and leave a comment for the Sysop. The Bulletin Board is your
  891. source for BIBL updates. Registered users may download other
  892. BIBL utilities from the board.
  893.  
  894.       
  895.